home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Cream of the Crop 22
/
Cream of the Crop 22.iso
/
os2
/
prgu101.zip
/
PRGUSER.DOC
< prev
next >
Wrap
Text File
|
1996-11-26
|
15KB
|
422 lines
PrgUser(c)
v1.01
MAXimus 3.0 User Purge Maintenance Utility
WYSIWYG
By: Gary Zarzycki
Internet: gary.zarzycki@pnet.playcom.com
zarzycki@flash.net
FidoNet 1:300/43
PrgUser
Contents
Introduction........................................... 1
License Agreement...................................... 1
Installation.......................................... 2
PrgUser Configuration File............................. 3
ErrorLevel Exits....................................... 6
(i)
PrgUser
1.0 General.
1.1 Introduction.
PrgUser comes in two flavors, DOS and OS/2 and use a common
PRGUSER.CTL file for either. PrgUser runs as a unattended
maintenance application to purge old users from your USER.BBS
file as configured in your PRGUSER.CTL control file. PrgUser
also cleans the message area pointer files of the purged
users, purges your OLR\DATS of purged users if they exist, and
Automatically Purges/Re-Index's the pointers for your MUeD or
UEDit's USER.EXT file, if it exists. PrgUser can also be
configured to maintain your MAX CALLERS.BBS file and Purge old
users from your CBK CALLBACK.DAT file, if you use CallBack for
your User Verifications. PrgUser will check MAXimus for
activity and will not purge if active to prevent damaging your
user data base. Sorry, Prguser cannot handle USER.BBS files
in excess of 4500 users.
PRGUSER allows up to 30 different 'PURGE' commands in the
PRGUSER.CTL file. These can be set by Access Level, Days
Lapsed since last call, and optionally by maximum calls to
your BBS. PRGUSER will *NOT* purge any user that has been set
to PERMENENT, on the same scheme, if a user has been set to
DELETE, PRGUSER will purge this user.
PRGUSER also allows you to set your Logging Style, either
MAXimus/Binkley style, or FrontDoor style. The log gives you
details of the purging including users names that were purged.
The log can be your BBS log file, or Front End Log, as long as
the Log file is not is use by a application.
1.2 PrgUser - Copywrite 1995
Although, for my protection I have PrgUser Copywrited, it is
being distributed as FreeWare for use by MAXimus Sysops in a
non-commercial environment. You may not modify or disassemble
PrgUser for any reason without written permission.
If someone wishes to use PrgUser commercially, they must
contact me concerning a license to do so, and are prohibited
from using PrgUser commercially unless a single user or site
license is obtained from me. Fees for such is as follows:
Commercial single user License................ $ 10.00ea
Commercial Multi user site License............ $ 50.00
(1)
PrgUser
2.0 Installation.
2.1 Setting up a Directory.
Make a subdirectory using the MD command from your MAXimus
subdirectory for PrgUser, then log into this new subdirectory.
EXAMPLE: MD PRGUSER
CD PRGUSER
Copy the PrgUser files into this subdirectory.
2.2 Executing PRGUSER
PRGUSER can be executed from the command line as follows:
drive:\path\PRGUSER <drive:\path>
Where Drive:Path is where you have your PRGUSER.EXE and
PRGUSER.CTL files. If you log into the PRGUSER subdirectory,
the a simple PrgUser will execute the program. Optionally
PrgUser can be executed from any subdirectory if you include
the <drive:\path> so it can find it's config file. PrgUser
will use it's Prguser.Ctl and your MAXimus environmental
variable maximus= to find all other files. A over-ride option
is included in the PrgUser.Ctl file to find the MAX.PRM file.
Prguser uses one of these options to find your MAX.PRM file.
2.3 Unattended Maintenance Operation.
Set up a maintenance event, either daily or weekly in your BBS
or Front End Batch file. For example, if you use Front Door,
you would create a scheduled maintenance event with a error
level exit. Example Following has a maintenance event to do
daily maintenance with a errorlevel of 150.
:Top
FD
if errorlevel 200 goto bbscall
if errorlevel 160 goto ZMH
if errorlevel 150 goto DayMaint
if errorlevel 100 goto MailIN
if errorlevel 10 EXIT
if errorlevel 1 goto Error
:DayMaint
c:\max\prguser\prguser.exe c:\max\prguser
if errorlevel 255 ECHO ERROR OCCURED IN PrgUser
if errorlevel 5 ECHO ACTIVE FILE FOUND
GOTO Top
(2)
PrgUser
3.0 Configuration.
3.1 Setting up your PRGUSER.CTL file.
Description and usage of the PRGUSER.CTL commands are as follows.
MAXdir <drive:path>
-OPTIONAL-
Optionally this may be used for PrgUser to find your MAX
MAX.PRM file. Default uses your MAXimus environmental
variable set maximus=drive:path. Once Prguser finds your
MAX.PRM file, it will obtain information from it. This
option allows you to specify the full drive and path to a
MAX.PRM file if you need to do so. PrgUser will backup
your old USER.BBS file as USER.BAK
LogStyle FD
-OPTIONAL-
LogStyle FD controls the type of logging format you wish
to use. Default is MAXimus/Binkley type log format. If
wish to log to your FrontDoor, Intermail type logs, then
you can UnComment the LogStyle FD and PRGUSER will write
in this format. This is a Optional Parameter for PRGUSER.
LogFile <drive:path\filename>
-OPTIONAL-
By default, PrgUser will use the Log File specified in
your MAXimus MAX.CTL file, ie: MAX.PRM. For mutlitasking
applications, special environments, etc. you can use this
LogFile option to log your PrgUser information elsewhere.
LogFile is the full Drive:Path\Filename of a log you wish
to use. If you wish to log to separate log, then use this
and specify a path and filename you wish to use. Note,
make sure the log you use is not active with some other
application of a share violation will occure.
Purge <accesslevel> <dayslapsed> <times>
-REQUIRED-
The Purge Command with parameters controls how you wish to
purge your system files. Up to 30 different Purge
Commands with Parameters are acceptable. The Access Level
and DaysLapsed are required parameters, with Times being a
optional parameter.
(3)
PrgUser
3.0 Configuration.
3.1 Setting up your PRGUSER.CTL file (continued).
The 'A' command controls the access level you wish to
purge and must match as you have defined in you MAXimus
ACCESS.CTL file. For example, if you have Transient,
(Twit) set to 0, then a A0 would be used.
The 'D' command is the Days Lapsed since the caller has
logged onto the BBS. For example if you have D30, then
users that have not been on the BBS for 30 or more days
will be purged.
The 'T' command is a optional command which sets the
maximum times the user has logged onto the system. For
example, if you set a T50 with the A30 and D180, then
users with a access level of 30, with 180 or more days
since their last call to the system, and less then 50
logons to the system would be purged. If the user has
been on more then 50 times, they would not be purged.
Following is a example of the use of the Purge command in
your PRGUSER.CTL file.
Access Level DaysLapsed Times
──────────── ────────── ─────
Purge A0 D30
Purge A10 D45
Purge A20 D180
Purge A30 D180 T50
Purge A65535 D20
In the above example, the following action will occure.
In the first case, all users with a access level of 0 with
30 or more days since their last logon would be purged.
The second case, users with a access level of 10 that have
not logged on in 45 days would be purged. The third case,
users with a access level of 20 that have not logged on in
180 days would be purged. The fourth case, users with a
access level of 30 that have not logged on in 180 days,
and their total times on the system was 50 times or less
would be purged. The last example, users with a access
level of 65535, (hidden) and 20 or more days have lapsed
would be purged.
(4)
PrgUser
3.0 Configuration.
3.1 Setting up your PRGUSER.CTL file (continued).
If you use MUeD or UED's comment field, Prguser will
automatically check to see if the USER.EXT file exists by
obtaining the name and location from you MAX.PRM file. If
it exists, it will purge all comments that were linked to
the users that was purged and Re-Pack your USER.EXT file.
PrgUser will backup your old USER.EXT file as USER.UED.
PRGUSER will also automatically delete any QWK OLR\DATS
data files linked to a deleted user.
SavePrgRecords Y
-OPTIONAL-
Optionally, you can tell PRGUSER to save the USER.BBS
Records of the users purged. Each record purged will be
appended into the USER.PRG file. This feature is
compatable with MUeD and UED and very useful with MUeD's
Restore feature. PrgUser will obtain the filename and
location of your USER.PRG file from your MAX.PRM file. If
you wish to save the records, then Uncomment the
SavePrgRecords Y in the PRGUSER.CTL file. Warning, this
option can create a very large save file if you have a
busy system with a lot of records purged.
CallersBBS <dayslapsed>
-OPTIONAL-
If you have CALLERS.BBS turned on, and you wish PRGUSER to
maintain this data file for you, then you optionally
choose to uncomment it and set the days lapsed to purge.
For example, if you set CallersBBS 60, then all records
that are older then 60 days would be purged. PRGUSER will
find your CALLERS.BBS filename and location via your
MAX.PRM file. PrgUser will backup your old CALLERS.BBS as
CALLERS.BAK. If you do not have CALLERS.BBS, or do not
wish PRGUSER to maintain your CALLERS.BBS file for you,
then leave CallersBBS commented out with a semicolon.
(5)
PrgUser
3.0 Configuration.
3.1 Setting up your PRGUSER.CTL file (continued).
CallBack <drive:path>
-OPTIONAL-
If you use CallBack, and wish to have PRGUSER purge and
rebuild your CALLBACK.DAT file of users that are not in
your USER.BBS file, then UnComment this line and set the
Drive and Path to where your CallBack subdirectory resides
which contains your CALLBACK.DAT file. PrgUser will
backup your CALLBACK.DAT as CALLBACK.PRG.
4.0
4.1 Errorlevel Exits
Prguser supports three errorlevel exits as follows.
Errorlevel = 255
Most cases this will indicate a configuration error
with the status being displayed to the screen along
with logging to your log file.
Errorlevel = 5
This indicates that PrgUser aborted because a MAXimus
active file was found. If you do not specify a
different log file then you default MAXimus log file
as defined in your mAX.PRM file, PrgUser will not log
this error to your log file to prevent any share
violations or corruption of your log file.
Errorlevel = 0
PrgUser completed it's purge cycle. Status of the
purge process will be displayed to your screen and
reported in your log file.
(6)